Activating Real-Time Client API

Real-Time Client API is provided with Advanced Process Automation 4.9.6 and higher. It is installed as part of the Real-Time Client installation.

To enable and activate the Real-Time Client API:

1.

Verify that Real-Time Client 4.9.6 or higher is installed on the Real-Time Client machine.

For details, see the Advanced Process Automation Client and Designer Installation Guide.

2.

If Real-Time Designer is installed, proceed with Step 4.

3.

If Real-Time Designer is not installed, proceed with Step 7.

4.

In Real-Time Designer, open the System Settings window and set the SOAP Listener parameters.

a.

Set the SOAP Listener Enabled parameter to True.

b.

Set the SOAP Listener Port value to the required port.

The SOAP Listener port range is: 1024 - 65535.

5.

If you have a Shared Resources Environment, you must also configure the following parameters:

a.

Set the Maximal Port value to the highest port number in the available port range.

b.

Set the Minimal Port value to the lowest port number in the available port range.

c.

In the Port Publish Service URL field, enter the relevant URL for the Port publish service URL.

d.

Define the unique identifier to be used. To do this, select the Resolution Method from the drop-down list.

WindowsUsernameOnly

Example: johns

WindowsUsernameWithDomain

Example: nice_systems\johns

WindowsUsernameWithFQDN

Example: nice.com\johns

MachineNameWithSessionId

Example: <machine_name>.<session_id>

e.

Set the Use Shared Resources Mode parameter to True.

6.

Continue with Step 11.

7.

If Real-Time Designer is not installed, open the Real-Time Client configuration file, RTClient.exe.config.

Configure the Real-Time Client parameters, which also appear in the System Settings window.

8.

Search for the string SOAPListenerConfiguration.and find the following line:

<SOAPListenerConfiguration SOAPListenerEnabled="false" SOAPListenerPort="8080"/>

Do the following:

a.

Set the SOAPListenerEnabled parameter to true.

SOAPListenerEnabled="true"

b.

Set the SOAPListenerPort value to the required port.

Example: SOAPListenerPort="<port_number>"

The SOAP Listener port range is: 1024 - 65535.

Example:

<SOAPListenerConfiguration SOAPListenerEnabled="false" SOAPListenerPort="8080"

SOAPListenerUseSharedResourcesMode="false" SOAPListenerResolutionMethod="WindowsUsernameOnly"

SOAPListenerMinPort="41414" SOAPListenerMaxPort="41414" portPublishServiceUrl="http://1.1.1.39:7077/RTServer/services/RTClientService"/>

9.

If you do not have a Shared Resources Environment, continue with Step 11.

10.

If you have a Shared Resources Environment, search for the string SOAPListenerUseSharedResourcesMode="false", and change false to true.

You must also set the following parameters:

a.

Set the SOAPListenerMaximalPort value to the highest port number in the port range.

Search for the string: SOAPListenerMaxPort="41414" and replace 41414 with the highest port in the range.

Example: SOAPListenerMaxPort="<highest_port_number>"

b.

Set the SOAPListenerMinimalPort value to the lowest port number in the port range.

Search for the string: SOAPListenerMinPort="41414" and replace 41414 with the lowest port in the range.

Example: SOAPListenerMinPort="<lowest_port_number>"

c.

Enter the relevant URL for the Port publish service URL.

Search for the string: PortPublishServiceURL="http://1.9.65.66:7077/RTServer/services/RTClientService" and enter the relevant URL.

Example: PortPublishServiceURL="http://<Port_publish_service_URL>"

d.

Define the unique identifier to be used. Search for the string: SOAPListenerResolutionMethod="WindowsUsernameOnly" and depending on which unique identifier is used, replace WindowsUsernameOnly with one of the following parameters:

WindowsUsernameOnly

Example: johns

WindowsUsernameWithDomain

Example: nice_systems\johns

WindowsUsernameWithFQDN

Example: nice.com\johns

MachineNameWithSessionId

Example: <machine_name>.<session_id>

11.

To activate the Real-Time Client API:

a.

Run cmd.exe with Administrator privileges.

b.

In the command line, enter:

netsh http add urlacl url=http://+:<port_number>/ user=Users

c.

In a Shared Resources Environment, repeat Step b for each port in the range.

Example: netsh http add urlacl url=http://+:8080/ user=Users

12.

To verify that the Real-Time Client API is installed correctly, view the WSDL web page. Run the Real-Time Client, and using a web browser navigate to: http://localhost:8080/RTGeneralService?wsdl.

13.

Proceed to Implementing Real-Time Client API.